home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / pascal / shazam.exe / ADEMO1.DEF < prev    next >
Encoding:
Text File  |  1992-09-01  |  2.1 KB  |  58 lines
  1. .TUTORIAL - Adding Hint Text
  2.  
  3. The only difference between this and the prior program is the
  4. addition of hint text.  The ";;" (double semi-colon) is used to
  5. denote that hint text follows.  The "@@" (double "at" sign) denotes a
  6. comment.
  7.  
  8. SHAZAM uses an easy-going, lazy man's syntax; ie:  "Use it if you
  9. feel like it, but nothing's required."  In general, syntax is used
  10. mostly for [ SUBMENU ] and [ STATUS ] keywords.  In full form, it
  11. looks like:
  12.  
  13. |   [ SUBMENU ] label param kbXX cmXX hcXX   ;;hint text  @@ comment
  14. |   label param kbXX cmXX hcXX               ;;hint text  @@ comment
  15.  
  16. ...for [ STATUS ] contexts, like this:
  17.  
  18. |   [ STATUS ] hcXX , hcXX                 @@ comment
  19. |   param label kbXX cmXX                  @@ comment
  20.  
  21. If a "label" has whitespace, enclose in quotes.
  22.  
  23. Most times, you don't need much syntax.  SHAZAM extrapolates the
  24. "label" or "param" to figure out the kbXX, cmXX and hcXX symbols.  If
  25. you provide a symbol, it overrides what SHAZAM extrapolates.  This is
  26. useful in rare cases, when SHAZAM gets befuddled by a prefix of "cm",
  27. "kb" or "hc", like this:
  28.  
  29. |   [submenu] info               ;;PC-AT battery stuff
  30. |   CMOS Alt-F5                  ;;chokes on CMOS
  31. |   CMOS Alt-F5 cmXCMOS hcXCMOS  ;;CMOS without choke
  32.  
  33. Please see KEYWORD REFERENCE for more information.
  34.  
  35.  
  36. OBSERVATIONS
  37. ------------
  38. 1.  When you run this program, the hints appear on the StatusLine.
  39.  
  40. 2.  Select a menu item.  When the MsgBox appears, press Ctrl-F5.
  41.     SHAZAM has mapped the same default Key-to-Command as APP.PAS.
  42.  
  43. 3.  Press F1 for Help; note that a dummy help text file (*.TX) was
  44.     created from hint text, so the Help Compiler has something to do.
  45.  
  46.     When you're ready to start working on help text, change the
  47.     SETUP|Code|Help text to "Append" and regenerate.  This will
  48.     create a permanent *.TXT file using Hint Text for Help Text, to
  49.     give you a leg up on the help system.
  50.  
  51. @PA - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  52.  
  53.  
  54.  
  55. [ SUBMENU ] File        ;;file management        @@ these are hints
  56. Open                    ;;open a file
  57. Save                    ;;save current window
  58.